.TH E1432_GET_DECIMATION 3 E1432
.SH NAME
e1432_get_decimation \- Get decimation factor
.IX e1432_get_decimation(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_get_decimation(E1432ID hw, SHORTSIZ16 ID,
                                LONGSIZ32 *dec)
.cE
.SH DESCRIPTION

\fIe1432_get_decimation\fR gets the current decimation rate of a
channel.  This is the ratio between the "sample0" sample clock
frequency, and the effective sample rate of the data being acquired by
the channel.

The sample clock frequency is the clock frequency that is connected to
one of the VXI TTLTRG lines, if needed to synchronize several E1432
modules.  This clock frequency is normally, but not always, the
fundamental rate at which data is collected from the ADCs on the SCAs.
The effective sample rate is determined by the span specified with
\fIe1432_set_span\fR, and by the SCAs present in the hardware.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained with a
call to \fIe1432_create_channel_group\fR, or the ID of a single channel.

\fIdec\fR is a pointer to 32-bit int, and will be filled with the
current decimation factor.
.SH "RESET VALUE"
The reset value of \fIdec\fR is one.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_span, e1432_get_clock_freq
.ad
